From a112e20efbf8c32078c9f1095361225d92076f47 Mon Sep 17 00:00:00 2001 From: tsteven4 <13596209+tsteven4@users.noreply.github.com> Date: Mon, 13 Mar 2023 11:37:19 -0600 Subject: [PATCH] document spelling fixes. (#1035) * document spelling fixes. and deciphering of the arc filter project option interpolation. * improve line break insertion in build table. * reword some option documentation. * whitespace --- xmldoc/chapters/build.xml | 8 ++++---- xmldoc/chapters/styles.xml | 4 ++-- xmldoc/filters/bend.xml | 2 +- xmldoc/filters/options/arc-project.xml | 6 +++--- xmldoc/filters/options/track-seg2trk.xml | 2 +- xmldoc/filters/options/transform-rptname.xml | 2 +- xmldoc/filters/position.xml | 2 +- xmldoc/formats/options/dg-100-erase_only.xml | 2 +- xmldoc/formats/options/dg-200-erase_only.xml | 2 +- xmldoc/formats/options/exif-offset.xml | 2 +- xmldoc/formats/options/garmin-baud.xml | 6 +++--- xmldoc/formats/options/garmin_gpi-hide.xml | 6 +++--- xmldoc/formats/options/garmin_gpi-languagecode.xml | 2 +- xmldoc/formats/options/globalsat-dump-file.xml | 2 +- xmldoc/formats/options/skytraq-gps-week-rollover.xml | 2 +- xmldoc/formats/skytraq.xml | 2 +- 16 files changed, 26 insertions(+), 26 deletions(-) diff --git a/xmldoc/chapters/build.xml b/xmldoc/chapters/build.xml index 7c7f145ec..e0839d800 100644 --- a/xmldoc/chapters/build.xml +++ b/xmldoc/chapters/build.xml @@ -75,7 +75,7 @@ from our automated Docker builds.
Building with Qt Creator -Qt provides a lovely IDE (Integrated Development Evironment) with an +Qt provides a lovely IDE (Integrated Development Environment) with an editor and debugger. Its use is strongly encouraged for those new to C++. Once you have Qt correctly installed, just opening the CMakeLists.txt from @@ -118,7 +118,7 @@ customize your build of GPSBabel. - GPSBABEL_WITH_LIBUSB=no|pkgconfig|system*|included*|custom + GPSBABEL_WITH_LIBUSB = no|pkgconfig|system*|included*|custom note that libusb is NOT used on windows. @@ -162,7 +162,7 @@ be set with GPSBABEL_EXTRA_LINK_LIBRARIES and GPSBABEL_EXTRA_INCLUDE_DIRECTORIES - GPSBABEL_WITH_SHAPELIB=no|pkgconfig|included*|custom + GPSBABEL_WITH_SHAPELIB = no|pkgconfig|included*|custom @@ -196,7 +196,7 @@ GPSBABEL_EXTRA_INCLUDE_DIRECTORIES. - GPSBABEL_WITH_ZLIB=no|pkgconfig|included*|custom + GPSBABEL_WITH_ZLIB = no|pkgconfig|included*|custom diff --git a/xmldoc/chapters/styles.xml b/xmldoc/chapters/styles.xml index 2fa789a9b..e58d75c96 100644 --- a/xmldoc/chapters/styles.xml +++ b/xmldoc/chapters/styles.xml @@ -9,7 +9,7 @@ this can be done by a user with no programming experience by providing a GPSBabel style file. For a format to be described by a style file, it must be predictable and -generally readable by humant. Formats with binary or unreadable content +generally readable by a human. Formats with binary or unreadable content are not good fits for this scheme. It should have: A fixed header at the beginning, if it has any at all. This is called a 'prologue'. @@ -403,7 +403,7 @@ OFIELDS are defined the same way in the style file. consists of three pieces of information: the FIELD TYPE, a DEFAULT VALUE, and a PRINTF CONVERSION (for output). In many cases, not all pieces are used, but all 3 pieces are required. Additionally, an fourth field is supported -that modifies the behaviour of the field being described. +that modifies the behavior of the field being described. FIELDS should be defined in the style file in the logical order that they appear in the data, from left to right. This is the order in which they are diff --git a/xmldoc/filters/bend.xml b/xmldoc/filters/bend.xml index a6a69e616..a0c4b6dcd 100644 --- a/xmldoc/filters/bend.xml +++ b/xmldoc/filters/bend.xml @@ -8,7 +8,7 @@ change in heading big enough. intersections. That means that, while navigating that route using a GPS unit, the course pointer would aim to the inside of that curve or intersection, and only when you have passed that point will the GPS -aim to the next waypoint in the route. This behaviour is useful in +aim to the next waypoint in the route. This behavior is useful in marine navigation but when biking, for instance, it may be a bit late to decide where to turn to in an intersection. diff --git a/xmldoc/filters/options/arc-project.xml b/xmldoc/filters/options/arc-project.xml index 390c4dc60..022cbfa27 100644 --- a/xmldoc/filters/options/arc-project.xml +++ b/xmldoc/filters/options/arc-project.xml @@ -4,9 +4,9 @@ closest segment, or over the nearest point if option is used. -With and optinos, if -is possible, altitude, creation_time and microsecond fields of waypoints -are updated by interpolation. +With either the or option +the altitude and creation_time of the projected waypoints +are updated, if possible, by interpolation from the route or track data. This is most useful if you are trying to obtain the closest points in diff --git a/xmldoc/filters/options/track-seg2trk.xml b/xmldoc/filters/options/track-seg2trk.xml index 50e41b0e5..3853a347e 100644 --- a/xmldoc/filters/options/track-seg2trk.xml +++ b/xmldoc/filters/options/track-seg2trk.xml @@ -1,6 +1,6 @@ This option splits tracks at segment boundaries into multiple tracks. This -is useful to restore the behaviour of GPSBabel versions up to 1.3.6 which +is useful to restore the behavior of GPSBabel versions up to 1.3.6 which didn't support track segment markers and automatically put each segment into a separate track. diff --git a/xmldoc/filters/options/transform-rptname.xml b/xmldoc/filters/options/transform-rptname.xml index 8d74bc38b..d3363f3ed 100644 --- a/xmldoc/filters/options/transform-rptname.xml +++ b/xmldoc/filters/options/transform-rptname.xml @@ -4,7 +4,7 @@ With this option you can decide to let GPSBabel name generated route points acco GPSBabel creates route points during the transformation process named "RPTnnn" where nnn is a numeric part. -Using this option GPSBabel can be configured to replace the "RPT" part of the generated names by the name of the source track during the transformation process. This is especially usefull if several differently named tracks are contained in the source file which should each be transformed into routes. +Using this option GPSBabel can be configured to replace the "RPT" part of the generated names by the name of the source track during the transformation process. This is especially useful if several differently named tracks are contained in the source file which should each be transformed into routes. Convert a GPX track to a GPX route, deleting the original track, naming the generated points like the original track name. diff --git a/xmldoc/filters/position.xml b/xmldoc/filters/position.xml index ef714aae5..ddab7211e 100644 --- a/xmldoc/filters/position.xml +++ b/xmldoc/filters/position.xml @@ -1,6 +1,6 @@ This filter removes points based on their proximity to each other. -For waypoints a point is removed if it is within the specified distance of a preceeding point. +For waypoints a point is removed if it is within the specified distance of a preceding point. For routes and tracks consecutive points are removed until the distance between the bracketing points is greater than the specified distance. diff --git a/xmldoc/formats/options/dg-100-erase_only.xml b/xmldoc/formats/options/dg-100-erase_only.xml index 6479f86f5..031f031ad 100644 --- a/xmldoc/formats/options/dg-100-erase_only.xml +++ b/xmldoc/formats/options/dg-100-erase_only.xml @@ -1,5 +1,5 @@ - Much like the this optio erases the data in the GPS. + Much like the this option erases the data in the GPS. It does not transfer data before doing so, making it much faster. This may be handy in a work flow where you want to transfer the data from the GPS, check it on a map, and then remove it from the unit. diff --git a/xmldoc/formats/options/dg-200-erase_only.xml b/xmldoc/formats/options/dg-200-erase_only.xml index 6479f86f5..031f031ad 100644 --- a/xmldoc/formats/options/dg-200-erase_only.xml +++ b/xmldoc/formats/options/dg-200-erase_only.xml @@ -1,5 +1,5 @@ - Much like the this optio erases the data in the GPS. + Much like the this option erases the data in the GPS. It does not transfer data before doing so, making it much faster. This may be handy in a work flow where you want to transfer the data from the GPS, check it on a map, and then remove it from the unit. diff --git a/xmldoc/formats/options/exif-offset.xml b/xmldoc/formats/options/exif-offset.xml index e76d48ba3..71f6e83ab 100644 --- a/xmldoc/formats/options/exif-offset.xml +++ b/xmldoc/formats/options/exif-offset.xml @@ -1,7 +1,7 @@ Uses the given value instead of the value from the tag OffsetTime, OffsetTimeOriginal or OffsetTimeDigitized. This is useful when the image doesn't contain an OffsetTime* tag and the offset is different from the local time, or when the image contains a tag that is incorrect. - The format of this option should match that of the tag OffsetTime*, specifcally it must be "+HH:MM" or "-HH:MM". + The format of this option should match that of the tag OffsetTime*, specifically it must be "+HH:MM" or "-HH:MM". If the camera was using China Standard Time, e.g. in the winter in Taiwan, then you should supply diff --git a/xmldoc/formats/options/garmin-baud.xml b/xmldoc/formats/options/garmin-baud.xml index 2743e1264..65d5565ab 100644 --- a/xmldoc/formats/options/garmin-baud.xml +++ b/xmldoc/formats/options/garmin-baud.xml @@ -10,9 +10,9 @@ gpsbabel -t -w -i garmin,baud=115200 -f /dev/ttyUSB0 -o gpx -F garmin-serial.gpx -At the end of the transfer, baud rate is switched to back to the default -of 9600. If connection breaks, the unit stucks at high baud rate, a power -cycle reverts to original state. +At the end of the transfer the baud rate is switched to back to the default +of 9600. If the connection breaks and the unit is stuck at a high baud rate power +cycling should restore the original baud rate. diff --git a/xmldoc/formats/options/garmin_gpi-hide.xml b/xmldoc/formats/options/garmin_gpi-hide.xml index bed5ff9df..0ef7a843a 100644 --- a/xmldoc/formats/options/garmin_gpi-hide.xml +++ b/xmldoc/formats/options/garmin_gpi-hide.xml @@ -1,7 +1,7 @@ - For a large list of points (or whyever) it can be useful when - no bitmaps are displayed on device. With this option no bitmap - is stored and displayed. + For a large list of points it may be desirable if + no bitmaps are displayed on the device. With this option no bitmaps + are stored and displayed. diff --git a/xmldoc/formats/options/garmin_gpi-languagecode.xml b/xmldoc/formats/options/garmin_gpi-languagecode.xml index 68d84616f..3c399ab0a 100644 --- a/xmldoc/formats/options/garmin_gpi-languagecode.xml +++ b/xmldoc/formats/options/garmin_gpi-languagecode.xml @@ -1,6 +1,6 @@ Garmin points of interest files may contain data in two languages. -If you attempt to read a dual language Garmin points of interest file without specifiying which language +If you attempt to read a dual language Garmin points of interest file without specifying which language to use GPSBabel will print an error message containing the language codes used in the file. Subsequently you may use one of these codes with the languagecode option to specify which language to use. diff --git a/xmldoc/formats/options/globalsat-dump-file.xml b/xmldoc/formats/options/globalsat-dump-file.xml index be68763c4..4db99d7c9 100644 --- a/xmldoc/formats/options/globalsat-dump-file.xml +++ b/xmldoc/formats/options/globalsat-dump-file.xml @@ -2,7 +2,7 @@ The dump-file option is primarily for debugging is module. It lets you provide a file which contains the raw stream of bytes coming from the device. This is useful for capturing device state to describe to a -developer that can't actually access hte physical device as well as mocking +developer that can't actually access the physical device as well as mocking the entire device for automated regression testing. diff --git a/xmldoc/formats/options/skytraq-gps-week-rollover.xml b/xmldoc/formats/options/skytraq-gps-week-rollover.xml index d3a1651f6..56a9cc3fa 100644 --- a/xmldoc/formats/options/skytraq-gps-week-rollover.xml +++ b/xmldoc/formats/options/skytraq-gps-week-rollover.xml @@ -31,7 +31,7 @@ which roll over to 0 every 1024 weeks (close to 20 years). -The default behaviour when gps-week-rollover isn't given (or is a negative number) +The default behavior when gps-week-rollover isn't given (or is a negative number) is to assume the input data has been logged within the preceding 1024 weeks from the time gpsbabel is run, which should be perfectly fine in almost all cases. diff --git a/xmldoc/formats/skytraq.xml b/xmldoc/formats/skytraq.xml index 2e828b40c..1682184ca 100644 --- a/xmldoc/formats/skytraq.xml +++ b/xmldoc/formats/skytraq.xml @@ -75,7 +75,7 @@ use this format to read its memory. -Windows users of GPSBabel version 1.5.2 or less may have to explicitly specifiy a bit rate of 115200 or lower. +Windows users of GPSBabel version 1.5.2 or less may have to explicitly specify a bit rate of 115200 or lower. Command showing skytraq download of tracks and erasing the logger on Linux -- 2.30.2